IRIX Base Documentation 2001 May/SGI IRIX Base Documentation 2001 May.iso/usr/share/catman/u_man/cat3/Tk/radiobutton.z/radiobutton

Text File | 1998-10-30 | 18.8 KB | 331 lines

rrrraaaaddddiiiioooobbbbuuuuttttttttoooonnnn((((3333TTTTkkkk))))                                              rrrraaaaddddiiiioooobbbbuuuuttttttttoooonnnn((((3333TTTTkkkk))))



NNNNAAAAMMMMEEEE
     radiobutton - Create and manipulate radiobutton widgets

SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
     rrrraaaaddddiiiioooobbbbuuuuttttttttoooonnnn _p_a_t_h_N_a_m_e ?_o_p_t_i_o_n_s?

SSSSTTTTAAAANNNNDDDDAAAARRRRDDDD OOOOPPPPTTTTIIIIOOOONNNNSSSS
     aaaaccccttttiiiivvvveeeeBBBBaaaacccckkkkggggrrrroooouuuunnnndddd  ccccuuuurrrrssssoooorrrr               hhhhiiiigggghhhhlllliiiigggghhhhttttTTTThhhhiiiicccckkkknnnneeeessssssss  ttttaaaakkkkeeeeFFFFooooccccuuuussss     |
     aaaaccccttttiiiivvvveeeeFFFFoooorrrreeeeggggrrrroooouuuunnnndddd  ddddiiiissssaaaabbbblllleeeeddddFFFFoooorrrreeeeggggrrrroooouuuunnnndddd   iiiimmmmaaaaggggeeee               tttteeeexxxxtttt          |
     aaaannnncccchhhhoooorrrr            ffffoooonnnntttt                 jjjjuuuussssttttiiiiffffyyyy             tttteeeexxxxttttVVVVaaaarrrriiiiaaaabbbblllleeee  |
     bbbbaaaacccckkkkggggrrrroooouuuunnnndddd        ffffoooorrrreeeeggggrrrroooouuuunnnndddd           ppppaaaaddddXXXX                uuuunnnnddddeeeerrrrlllliiiinnnneeee     |
     bbbbiiiittttmmmmaaaapppp            hhhhiiiigggghhhhlllliiiigggghhhhttttCCCCoooolllloooorrrr       ppppaaaaddddYYYY                wwwwrrrraaaappppLLLLeeeennnnggggtttthhhh    |
     bbbboooorrrrddddeeeerrrrWWWWiiiiddddtttthhhh       hhhhiiiigggghhhhlllliiiigggghhhhttttBBBBaaaacccckkkkggggrrrroooouuuunnnndddd  rrrreeeelllliiiieeeeffff

     See the ``options'' manual entry for details on the standard options.

WWWWIIIIDDDDGGGGEEEETTTT----SSSSPPPPEEEECCCCIIIIFFFFIIIICCCC OOOOPPPPTTTTIIIIOOOONNNNSSSS
     Name:           ccccoooommmmmmmmaaaannnndddd
     Class:          CCCCoooommmmmmmmaaaannnndddd
     Command-Line Switch:----ccccoooommmmmmmmaaaannnndddd

          Specifies a Tcl command to associate with the button.  This command
          is typically invoked when mouse button 1 is released over the button
          window.  The button's global variable (----vvvvaaaarrrriiiiaaaabbbblllleeee option) will be
          updated before the command is invoked.

     Name:           hhhheeeeiiiigggghhhhtttt
     Class:          HHHHeeeeiiiigggghhhhtttt
     Command-Line Switch:----hhhheeeeiiiigggghhhhtttt

          Specifies a desired height for the button.  If an image or bitmap is
          being displayed in the button then the value is in screen units
          (i.e. any of the forms acceptable to TTTTkkkk____GGGGeeeettttPPPPiiiixxxxeeeellllssss); for text it is
          in lines of text.  If this option isn't specified, the button's
          desired height is computed from the size of the image or bitmap or
          text being displayed in it.

     Name:           iiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn                                              |
     Class:          IIIInnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn                                              |
     Command-Line Switch:----iiiinnnnddddiiiiccccaaaattttoooorrrroooonnnn                                         |

          Specifies whether or not the indicator should be drawn.  Must be a  |
          proper boolean value.  If false, the rrrreeeelllliiiieeeeffff option is ignored and   |
          the widget's relief is always sunken if the widget is selected and  |
          raised otherwise.

     Name:           sssseeeelllleeeeccccttttCCCCoooolllloooorrrr                                              |
     Class:          BBBBaaaacccckkkkggggrrrroooouuuunnnndddd                                               |
     Command-Line Switch:----sssseeeelllleeeeccccttttccccoooolllloooorrrr                                         |






                                                                        PPPPaaaaggggeeee 1111






rrrraaaaddddiiiioooobbbbuuuuttttttttoooonnnn((((3333TTTTkkkk))))                                              rrrraaaaddddiiiioooobbbbuuuuttttttttoooonnnn((((3333TTTTkkkk))))



          Specifies a background color to use when the button is selected.  If|
          iiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn is true, the color applicies to the indicator.  If      |
          iiiinnnnddddiiiiccccaaaattttoooorrrrOOOOnnnn is false, this color is used as the background for the  |
          entire widget, in place of bbbbaaaacccckkkkggggrrrroooouuuunnnndddd or aaaaccccttttiiiivvvveeeeBBBBaaaacccckkkkggggrrrroooouuuunnnndddd, whenever |
          the widget is selected.  If specified as an empty string, no special|
          color is used for displaying when the widget is selected.

     Name:           sssseeeelllleeeeccccttttIIIImmmmaaaaggggeeee                                              |
     Class:          SSSSeeeelllleeeeccccttttIIIImmmmaaaaggggeeee                                              |
     Command-Line Switch:----sssseeeelllleeeeccccttttiiiimmmmaaaaggggeeee                                         |

          Specifies an image to display (in place of the iiiimmmmaaaaggggeeee option) when   |
          the radiobutton is selected.  This option is ignored unless the     |
          iiiimmmmaaaaggggeeee option has been specified.

     Name:           ssssttttaaaatttteeee
     Class:          SSSSttttaaaatttteeee
     Command-Line Switch:----ssssttttaaaatttteeee

          Specifies one of three states for the radiobutton:  nnnnoooorrrrmmmmaaaallll, aaaaccccttttiiiivvvveeee,
          or ddddiiiissssaaaabbbblllleeeedddd.  In normal state the radiobutton is displayed using the
          ffffoooorrrreeeeggggrrrroooouuuunnnndddd and bbbbaaaacccckkkkggggrrrroooouuuunnnndddd options.  The active state is typically
          used when the pointer is over the radiobutton.  In active state the
          radiobutton is displayed using the aaaaccccttttiiiivvvveeeeFFFFoooorrrreeeeggggrrrroooouuuunnnndddd and
          aaaaccccttttiiiivvvveeeeBBBBaaaacccckkkkggggrrrroooouuuunnnndddd options.  Disabled state means that the radiobutton|
          should be insensitive:  the default bindings will refuse to activate|
          the widget and will ignore mouse button presses.  In this state the
          ddddiiiissssaaaabbbblllleeeeddddFFFFoooorrrreeeeggggrrrroooouuuunnnndddd and bbbbaaaacccckkkkggggrrrroooouuuunnnndddd options determine how the
          radiobutton is displayed.

     Name:           vvvvaaaalllluuuueeee
     Class:          VVVVaaaalllluuuueeee
     Command-Line Switch:----vvvvaaaalllluuuueeee

          Specifies value to store in the button's associated variable
          whenever this button is selected.

     Name:           vvvvaaaarrrriiiiaaaabbbblllleeee
     Class:          VVVVaaaarrrriiiiaaaabbbblllleeee
     Command-Line Switch:----vvvvaaaarrrriiiiaaaabbbblllleeee

          Specifies name of global variable to set whenever this button is
          selected.  Changes in this variable also cause the button to select
          or deselect itself.  Defaults to the value sssseeeelllleeeecccctttteeeeddddBBBBuuuuttttttttoooonnnn.

     Name:           wwwwiiiiddddtttthhhh
     Class:          WWWWiiiiddddtttthhhh
     Command-Line Switch:----wwwwiiiiddddtttthhhh

          Specifies a desired width for the button.  If an image or bitmap is
          being displayed in the button, the value is in screen units (i.e.
          any of the forms acceptable to TTTTkkkk____GGGGeeeettttPPPPiiiixxxxeeeellllssss); for text it is in



                                                                        PPPPaaaaggggeeee 2222






rrrraaaaddddiiiioooobbbbuuuuttttttttoooonnnn((((3333TTTTkkkk))))                                              rrrraaaaddddiiiioooobbbbuuuuttttttttoooonnnn((((3333TTTTkkkk))))



          characters.  If this option isn't specified, the button's desired
          width is computed from the size of the image or bitmap or text being
          displayed in it.


DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     The rrrraaaaddddiiiioooobbbbuuuuttttttttoooonnnn command creates a new window (given by the _p_a_t_h_N_a_m_e
     argument) and makes it into a radiobutton widget.  Additional options,
     described above, may be specified on the command line or in the option
     database to configure aspects of the radiobutton such as its colors,
     font, text, and initial relief.  The rrrraaaaddddiiiioooobbbbuuuuttttttttoooonnnn command returns its
     _p_a_t_h_N_a_m_e argument.  At the time this command is invoked, there must not
     exist a window named _p_a_t_h_N_a_m_e, but _p_a_t_h_N_a_m_e's parent must exist.

     A radiobutton is a widget that displays a textual string, bitmap or image|
     and a diamond called an _i_n_d_i_c_a_t_o_r.  If text is displayed, it must all be |
     in a single font, but it can occupy multiple lines on the screen (if it  |
     contains newlines or if wrapping occurs because of the wwwwrrrraaaappppLLLLeeeennnnggggtttthhhh option)|
     and one of the characters may optionally be underlined using the         |
     uuuunnnnddddeeeerrrrlllliiiinnnneeee option.  A radiobutton has all of the behavior of a simple
     button: it can display itself in either of three different ways,
     according to the ssssttttaaaatttteeee option; it can be made to appear raised, sunken,
     or flat; it can be made to flash; and it invokes a Tcl command whenever
     mouse button 1 is clicked over the check button.

     In addition, radiobuttons can be _s_e_l_e_c_t_e_d.  If a radiobutton is selected,|
     the indicator is normally drawn with a sunken relief and a special color,|
     and a Tcl variable associated with the radiobutton is set to a particular|
     value.  If the radiobutton is not selected, the indicator is drawn with a|
     raised relief and no special color.  Typically, several radiobuttons     |
     share a single variable and the value of the variable indicates which    |
     radiobutton is to be selected.  When a radiobutton is selected it sets   |
     the value of the variable to indicate that fact;  each radiobutton also  |
     monitors the value of the variable and automatically selects and         |
     deselects itself when the variable's value changes.  By default the      |
     variable sssseeeelllleeeecccctttteeeeddddBBBBuuuuttttttttoooonnnn is used;  its contents give the name of the      |
     button that is selected, or the empty string if no button associated with|
     that variable is selected.  The name of the variable for a radiobutton,  |
     plus the variable to be stored into it, may be modified with options on  |
     the command line or in the option database.  Configuration options may   |
     also be used to modify the way the indicator is displayed (or whether it |
     is displayed at all).  By default a radio button is configured to select
     itself on button clicks.


WWWWIIIIDDDDGGGGEEEETTTT CCCCOOOOMMMMMMMMAAAANNNNDDDD
     The rrrraaaaddddiiiioooobbbbuuuuttttttttoooonnnn command creates a new Tcl command whose name is _p_a_t_h_N_a_m_e.
     This command may be used to invoke various operations on the widget.  It
     has the following general form:

          _p_a_t_h_N_a_m_e _o_p_t_i_o_n ?_a_r_g _a_r_g ...?




                                                                        PPPPaaaaggggeeee 3333






rrrraaaaddddiiiioooobbbbuuuuttttttttoooonnnn((((3333TTTTkkkk))))                                              rrrraaaaddddiiiioooobbbbuuuuttttttttoooonnnn((((3333TTTTkkkk))))



     _O_p_t_i_o_n and the _a_r_gs determine the exact behavior of the command.  The
     following commands are possible for radiobutton widgets:

     _p_a_t_h_N_a_m_e ccccggggeeeetttt _o_p_t_i_o_n
          Returns the current value of the configuration option given by      |
          _o_p_t_i_o_n.  _O_p_t_i_o_n may have any of the values accepted by the          |
          rrrraaaaddddiiiioooobbbbuuuuttttttttoooonnnn command.

     _p_a_t_h_N_a_m_e ccccoooonnnnffffiiiigggguuuurrrreeee ?_o_p_t_i_o_n? ?_v_a_l_u_e _o_p_t_i_o_n _v_a_l_u_e ...?
          Query or modify the configuration options of the widget.  If no
          _o_p_t_i_o_n is specified, returns a list describing all of the available
          options for _p_a_t_h_N_a_m_e (see TTTTkkkk____CCCCoooonnnnffffiiiigggguuuurrrreeeeIIIInnnnffffoooo for information on the
          format of this list).  If _o_p_t_i_o_n is specified with no _v_a_l_u_e, the
          command returns a list describing the one named option (this list
          will be identical to the corresponding sublist of the value returned
          if no _o_p_t_i_o_n is specified).  If one or more _o_p_t_i_o_n-_v_a_l_u_e pairs are
          specified, the command modifies the given widget option(s) to have
          the given value(s);  in this case the command returns an empty
          string.  _O_p_t_i_o_n may have any of the values accepted by the
          rrrraaaaddddiiiioooobbbbuuuuttttttttoooonnnn command.

     _p_a_t_h_N_a_m_e ddddeeeesssseeeelllleeeecccctttt
          Deselects the radiobutton and sets the associated variable to an
          empty string.  If this radiobutton was not currently selected, the
          command has no effect.

     _p_a_t_h_N_a_m_e ffffllllaaaasssshhhh
          Flashes the radiobutton.  This is accomplished by redisplaying the
          radiobutton several times, alternating between active and normal
          colors.  At the end of the flash the radiobutton is left in the same
          normal/active state as when the command was invoked.  This command
          is ignored if the radiobutton's state is ddddiiiissssaaaabbbblllleeeedddd.

     _p_a_t_h_N_a_m_e iiiinnnnvvvvooookkkkeeee
          Does just what would have happened if the user invoked the
          radiobutton with the mouse: selects the button and invokes its
          associated Tcl command, if there is one.  The return value is the
          return value from the Tcl command, or an empty string if there is no
          command associated with the radiobutton.  This command is ignored if
          the radiobutton's state is ddddiiiissssaaaabbbblllleeeedddd.

     _p_a_t_h_N_a_m_e sssseeeelllleeeecccctttt
          Selects the radiobutton and sets the associated variable to the
          value corresponding to this widget.


BBBBIIIINNNNDDDDIIIINNNNGGGGSSSS
     Tk automatically creates class bindings for radiobuttons that give them
     the following default behavior:






                                                                        PPPPaaaaggggeeee 4444






rrrraaaaddddiiiioooobbbbuuuuttttttttoooonnnn((((3333TTTTkkkk))))                                              rrrraaaaddddiiiioooobbbbuuuuttttttttoooonnnn((((3333TTTTkkkk))))



     [1]  The radiobutton activates whenever the mouse passes over it and
          deactivates whenever the mouse leaves the radiobutton.

     [2]  When mouse button 1 is pressed over a radiobutton it is invoked (it |
          becomes selected and the command associated with the button is      |
          invoked, if there is one).

     [3]  When a radiobutton has the input focus, the space key causes the    |
          radiobutton to be invoked.

     If the radiobutton's state is ddddiiiissssaaaabbbblllleeeedddd then none of the above actions
     occur:  the radiobutton is completely non-responsive.

     The behavior of radiobuttons can be changed by defining new bindings for
     individual widgets or by redefining the class bindings.


KKKKEEEEYYYYWWWWOOOORRRRDDDDSSSS
     radiobutton, widget




































                                                                        PPPPaaaaggggeeee 5555